DNP3 Emerson EIE – UIS Command Component Parameters

Devices > Remote Devices > DNP3 Emerson EIE > UIS Command Component Parameters

UIS Command Component Parameters

The following tables list and describe the parameters specific to the UIS command component types for this remote device:

CLRHSTXA
CYUPDTPT
CYWAITPT
DG_F_DEV
DG_T_DEV

For more general information about UIS command component parameters, see UIS Command Components. The DG_F_DEV (Get data group from device) and DG_T_DEV (Send data group to device) command component types are configured in the template file. The other command component types are considered ‘special’ and are defined in the EIE editor code. See Special UIS Command Component Types for more information.

CLRHSTXA

Clear All History Tx Info clears all historical data group caches. CLRHSTXA has no command parameters.

Note: If you clear all caches using a UIS command, the cache values in each transaction of historical data groups are not reset; past transactions continue to display actual values. This is done for performance reasons so that each DDS transaction does not have to be updated. The driver ignores these cached values after the command has been issued.

CYUPDTPT

Update CygNet Point updates the record for a CygNet point. CYUPDTPT has the following command parameters:

Parameter	Required	Description
FOnErr	No	Fail cmd on update error indicates to abort the UIS command if any update errors are encountered. The errors that might come up include: if the point specified in the Fac, Serv, Site, or UDC parameters does not exist, or if the point exists in a different UIS and any messaging errors or communication failure to that service comes up.
Fac	Yes	Facility for pt identifies the facility of the point to update.
Serv	No	Service for pt identifies the SERVICE of the point to update.
Site	No	Site for pt identifies the SITE of the point to update.
UDC	Yes	UDC for pt identifies the UDC of the point to update.
UType	No	Update type indicates the type of update. Value options are 0 - 3, where 0=Completion, 1=Success, 2=Failure, 3=Creation.
UsrMsk	No	User bit mask specifies the user bit mask of the point to update.
UsrVal	No	User bit value to match specifies the user bit value to match when updating the point record.
Value	No	Value indicates the point value to update.

CYWAITPT

Wait for CygNet Point signals the UIS to wait to perform a command until the value of the specified CygNet point changes to a specified value.

CYWAITPT must be the first command component added to a UIS command. You cannot add other instances of CYWAITPT to a UIS command.

CYWAITPT has the following command parameters:

Parameter	Required	Description
Dur	Yes	Duration is the amount of time (in HH:MM:SS or HH:MM or HH) for the UIS command to wait for the point value to change before timing out.
FOnErr	No	Fail on point error indicates to abort the UIS command if any error conditions are encountered. The point errors that might come up include: if the point specified in the Fac, Serv, Site, or UDC parameters does not exist, or if the point exists in a different UIS and any messaging errors or communication failure to that service comes up.
Fac	Yes	Facility for pt identifies the facility of the point on which to wait for the point value to change before performing the UIS command.
Int	Yes	Interval indicates the frequency (in HH:MM:SS or HH:MM or HH) with which the UIS will check the point’s value to see if it has changed.
Serv	No	Service for pt identifies the SERVICE of the point on which to wait for the point value to change before performing the UIS command.
Site	No	Site for pt identifies the SITE of the point on which to wait for the point value to change before performing the UIS command.
UDC	Yes	UDC for pt identifies the UDC of the point on which to wait for the point value to change before performing the UIS command.
UsrMsk	No	User bit mask specifies the user bit mask on which to wait for the status bit change before issuing the UIS command. Note: The user status bit parameters (UsrMsk and UsrVal) only apply to the extended status field of the point record, so they will not match anything in the base status.
UsrVal	No	User bit value to match specifies the user bit value to match before issuing the UIS command.
Value	No	Value to match specifies the value on which to wait for the point to change to before issuing the UIS command. Note: You can set parameters for both the point user status AND point value. So you can match either one by itself, or you can specify that both must match your parameter values.

DG_F_DEV

Get data group from device retrieves a data group from a field device. The Parent XML Element is uccRecvParms. The following parameters are available for each specified data group type.

Data-Group Type	Parameter	Required	Description
Data Groups containing dgCat="File"	FileName	Yes (see Note in Description)	Name of file to read. Value options are strings. Note: The parameter is required only when the data group is missing a value for fileName in the device template.
Event	Class1	No	Get class 1 events Value options are Boolean.
	Class2	No	Get class 2 events Value options are Boolean.
	Class3	No	Get class 3 events Value options are Boolean.
	Count	No	Max events Value options are integers.
	ptType	No	Point type Value options are strings.
	Variation	No	Point type variation Value options are integers.
HistAlarm	Cnt	No	Max Records to Read specifies the maximum possible number of records to read in a single transaction. Value options are integers.
	EDate	No	End date defines the ending date and time. Value options are strings.
	GetLatest	No	Get Latest? defines whether or not to retrieve history from the latest successfully read history record (the cache). Value options are Boolean.
	SDate	No	Start date defines the starting date and time. Value options are strings.
	Seq	No	Sequence # defines the first sequence number in the requested range. Value options are integers.
HistEvent	Cnt	No	Max Records to Read specifies the maximum possible number of records to read in a single transaction. Value options are integers.
	EDate	No	End date defines the ending date and time. Value options are strings.
	GetLatest	No	Get Latest? defines whether or not to retrieve history from the latest successfully read history record (the cache). Value options are Boolean.
	SDate	No	Start date defines the starting date and time.
	Seq	No	Sequence # defines the first sequence number in the requested range. Value options are integers.
HistGenD HistGenH HistGenM HistGenW HistStaD HistStaH HistStaM HistStaW HistUser	Cnt	No	Max Records to Read specifies the maximum possible number of records to read in a single transaction. Value options are integers.
	EDate	No	End date defines the ending date and time. Value options are strings.
	GetLatest	No	Get Latest? defines whether or not to retrieve history from the latest successfully read history record (the cache). Value options are Boolean.
	SDate	No	Start Date defines the starting date and time.
	Seq	No	Sequence # defines the first sequence number in the requested range. Value options are integers.
SinglePt	DataType	No	Data Type defines the type of data stored at the specified point type. Value options are strings.
	Desc	No	Description Value options are strings.
	ElementId	Yes	PointType.Index specifies the point type and index number values used to retrieve data from a single element. Value options are strings.
	FacUdc	No	Facility.UDC for point processing provides a means to specify a UDC to which to map the specified data point; it requires a corresponding point in the Point Service (PNT). Value options are strings that specify a Facility.UDC combination.
	Variation	No	Point type variation Value options are char values.

DG_T_DEV

Send data group to device sends a data group to a field device. The parent XML Element is uccSendParms. The following parameters are available for each specified data group type.

Data-Group Type	Parameter	Required	Description
IntInd	IIN1.7	No	Device Restart Value options are Boolean.
SinglePt	Clear	No	BO: Clear Value options are Boolean.
	Count	No	BO: Count
	DataType	Yes	Data Type defines the type of data stored at the specified point type. Value options are strings.
	Desc	No	Description Value options are strings.
	ElementId	Yes	PointType.Index specifies the point type and index number values used to retrieve data from a single element. Value options are strings.
	FacUdc	No	Facility.UDC for point processing provides a means to specify a UDC to which to map the specified data point; it requires a corresponding point in the Point Service (PNT). Value options are strings that specify a Facility.UDC combination.
	Len	Yes (String point type only)	Len specifies the number of bytes in a data-group element or register. Only used for String point type. Value must be a positive whole number.
	PulseLatch	No	BO: Pulse/Latch/No-op Value options are strings.
	TimeOff	No	BO: Time off (ms) Value options are integers.
	TimeOn	No	BO: Time on (ms) Value options are integers.
	TripClose	No	BO: Trip/Close Value options are strings.
	Value	Yes	Value defines a value to be sent to the specified item. Value options are floating-point numbers.
	Variation	No	Point type variation Value options are char values.